Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improved ref docs for model #2951

Merged
merged 25 commits into from
Feb 29, 2024
Merged

Improved ref docs for model #2951

merged 25 commits into from
Feb 29, 2024

Conversation

timotheeguerin
Copy link
Member

@timotheeguerin timotheeguerin commented Feb 23, 2024 •
edited
Loading

fix https://github.com/Azure/typespec-azure-pr/issues/3861
fix #2232
Generate docs for model properties and reference models within the same package
image

@azure-sdk
Copy link
Collaborator

azure-sdk commented Feb 23, 2024 •
edited
Loading

All changed packages have been documented.

@azure-sdk
Copy link
Collaborator

You can try these changes at https://cadlplayground.z22.web.core.windows.net/prs/2951/

Check the website changes at https://tspwebsitepr.z22.web.core.windows.net/prs/2951/

@timotheeguerin timotheeguerin mentioned this pull request Feb 26, 2024
Open
tjprescott
tjprescott reviewed Feb 26, 2024
View reviewed changes
Copy link
Member

@tjprescott tjprescott left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks fantastic! Thank you @timotheeguerin for working on this. Most of my comments are "food for thought" only, though before merging I think it would be good to decide what we should display when a model has no properties. To me, if I saw an empty table I would assume it's a bug.

@timotheeguerin
Copy link
Member Author

This looks fantastic! Thank you @timotheeguerin for working on this. Most of my comments are "food for thought" only, though before merging I think it would be good to decide what we should display when a model has no properties. To me, if I saw an empty table I would assume it's a bug.

that's fair, I don't have a strong opinion on this I can change

markcowl
markcowl approved these changes Feb 29, 2024
View reviewed changes
Copy link
Contributor

@markcowl markcowl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One unfortunate change in anonymous model representation, otherwise, lgtm

docs/libraries/http/reference/decorators.md Outdated Show resolved Hide resolved
@timotheeguerin timotheeguerin merged commit 02ed01e into microsoft:main Feb 29, 2024
14 checks passed
@timotheeguerin timotheeguerin deleted the ref-docs-models branch February 29, 2024 15:21
markcowl pushed a commit to markcowl/cadl that referenced this pull request Mar 8, 2024
@timotheeguerin @markcowl
Improved ref docs for model (microsoft#2951)
87e2559 
fix Azure/typespec-azure-pr#3861
fix microsoft#2232
Generate docs for model properties and reference models within the same
package
<img width="1213" alt="image"
src="https://github.com/microsoft/typespec/assets/1031227/ae7eccd0-97d8-401e-b07f-3375c7b41446">
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tjprescott tjprescott tjprescott left review comments

@markcowl markcowl markcowl approved these changes

@bterlson bterlson Awaiting requested review from bterlson bterlson is a code owner

@daviwil daviwil Awaiting requested review from daviwil

@allenjzhang allenjzhang Awaiting requested review from allenjzhang allenjzhang is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Documentation improvements
4 participants
@timotheeguerin @azure-sdk @markcowl @tjprescott